home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir41 / timstk11.zip / TS8051.HLP < prev    next >
Text File  |  1993-04-01  |  15KB  |  500 lines

  1. @@NO HELP
  2.  No help is available for this selection.  Please
  3.  refer to the TimeStack User's Guide for
  4.  additional help
  5.  
  6. @@File
  7.  The File menu lets you manipulate all files in
  8.  TimeStack.  This includes loading the hex file,
  9.  saving and restoring the node list, and getting
  10.  and putting the configuration to disk.
  11.  
  12. @@File Load
  13.  This prompts the name of the hex file.  The hex
  14.  file is given a default extension of .HEX if no
  15.  extension is entered.  If an extension is not
  16.  desired then enter the name as NAME. with a
  17.  period on the end.
  18.  
  19.  The hex file may be Motorola or Intel hex format.
  20.  
  21.  The hex file is automatically loaded if a
  22.  configuration file is loaded and there is a hex
  23.  filename specified in its configuration.
  24.  
  25. @@File Save
  26.  This name is used to write out the special node
  27.  list file.  The node list filename entered here
  28.  is the same name used in the menu File | Restore.
  29.  
  30.  The node list file is given a default extension
  31.  of .NOD if no extension is entered.  If an
  32.  extension is not desired then enter the name
  33.  as NAME. with a period on the end.
  34.  
  35.  The node list file is automatically loaded if a
  36.  configuration file is loaded and there is a node
  37.  list filename specified.
  38.  
  39. @@File Restore
  40.  The node list filename is entered here.  This
  41.  name is used to read in the special node list
  42.  file.  Any name entered here will also be used
  43.  by the menu File | Save.
  44.  
  45.  The node list file is given a default extension
  46.  of .NOD if no extension is entered.  If an
  47.  extension is not desired then enter the name
  48.  as NAME. with a period on the end.
  49.  
  50.  The node list file is automatically loaded if a
  51.  configuration file is loaded and there is a node
  52.  list filename specified.
  53.  
  54. @@File Get
  55.  The configuration of TimeStack is read in from
  56.  here.  Any name entered here will also be used
  57.  by the menu File | Put.
  58.  
  59.  The configuration file is given a default
  60.  extension of .CFG if no extension is entered.
  61.  If an extension is not desired then enter the
  62.  name as NAME. with a period on the end.
  63.  
  64.  If the configuration file xxxxxx.CFG, where
  65.  xxxxxx is the name of the program, is found
  66.  when TimeStack starts up, that configuration
  67.  is loaded.
  68.  
  69. @@File Put
  70.  The current TimeStack configuration is saved in
  71.  this file.  The configuration filename entered
  72.  here is the same name used in the menu
  73.  File | Get.
  74.  
  75.  The configuration file is given a default
  76.  extension of .CFG if no extension is entered.
  77.  If an extension is not desired then enter the
  78.  name as NAME. with a period on the end.
  79.  
  80. @@Analysis
  81.  The start and stop addresses of the analysis to
  82.  be done are entered here.  The cursor starts out
  83.  on the top line which is the start address.  The
  84.  hexadecimal start address obtained from a
  85.  program listing is entered here.
  86.  
  87.  Pressing ENTER moves to the stop address on
  88.  the next line.  A hexadecimal stop address
  89.  determined by inspecting the program listing
  90.  is entered.
  91.  
  92.  If the analysis is on a procedure that finishes
  93.  with a return from subroutine instruction, enter
  94.  a hexadecimal value that contains all F's such
  95.  as FFFF.  The analysis will automatically stop
  96.  when it finds a return from subroutine instruction.
  97.  
  98.  Pressing ESC from this line restores the
  99.  previous value and moves the cursor back up
  100.  to the start address line.
  101.  
  102. @@Analysis Abort Yes
  103.  The analysis may be aborted by pressing ESC
  104.  while it is running.
  105.  
  106.  Choosing 'Yes' at this time will stop the
  107.  analysis from completing.
  108.  
  109. @@Analysis Abort No
  110.  The analysis may be aborted by pressing ESC
  111.  while it is running.
  112.  
  113.  Choosing 'No' at this time will allow the
  114.  analysis to continue running.
  115.  
  116. @@Edit
  117.  Edit the instruction at the address entered.
  118.  The instruction must be a conditional branch,
  119.  a jump to subroutine, an indexed jump, or
  120.  an indexed jump to subroutine.  The type of
  121.  instruction will determine which menu is
  122.  displayed.
  123.  
  124. @@Edit Take
  125.  The choices for conditional branches are Take,
  126.  Fall, Normal, or Clear.
  127.  
  128.  This selection asks how many times to take the
  129.  conditional branch before it is allowed to
  130.  fall through.
  131.  
  132.  A value of zero indicates that the branch should
  133.  always be taken (ie. it never falls through).
  134.  
  135.  Example:
  136.         LDAA   #5
  137.     LOOP:   NOP
  138.         DECA
  139.         BNE    LOOP       ; TAKE 4
  140.         RTS
  141.  
  142.  In this example, it is correct for the conditional
  143.  branch BNE to be set to TAKE 4 times.  The fifth
  144.  time through the loop it falls through.
  145.  
  146. @@Edit Fall
  147.  The choices for conditional branches are Take,
  148.  Fall, Normal, or Clear.
  149.  
  150.  This selection asks how many times to fall through
  151.  the conditional branch before it is allowed to
  152.  be taken.
  153.  
  154.  A value of zero indicates that the branch should
  155.  always fall through (ie. it is never taken).
  156.  
  157.  Example:
  158.         LDAA   #6
  159.     LOOP:   DECA
  160.         BEQ    DONE       ; FALL 5
  161.         NOP
  162.         BRA    LOOP
  163.     DONE:   RTS
  164.  
  165.  In this example, it is correct for the conditional
  166.  branch BEQ to be set to FALL 5 times.  The sixth
  167.  time through the loop it is taken.
  168.  
  169.  
  170. @@Edit Normal
  171.  Treat the conditional branch as you would a normal
  172.  forward branch.  Both paths of the branch are
  173.  analyzed.
  174.  
  175. @@Edit Delete
  176.  Delete the branch from the special node list.
  177.  
  178. @@Edit JMP IND
  179.  The menu for jumps indirect first displays the
  180.  option to handle the jump indirect exactly as it
  181.  would a return from subroutine instruction.  If
  182.  this is not chosen then the address that should
  183.  be jumped to is requested.
  184.  
  185. @@Edit Clear JSR
  186.  The time and stack that was entered for this
  187.  jump subroutine may be cleared.
  188.  
  189.  Yes - clears this information.
  190.  
  191.  No - leaves the information.
  192.  
  193. @@Clear
  194.  It is possible to clear nodes in the Special
  195.  Nodes window one at a time using the Edit menu
  196.  but this is time consuming.  This option allows
  197.  clearing all nodes from the given starting
  198.  address through the given ending address,
  199.  inclusive.
  200.  
  201. @@Disasm
  202.  The Disassembly window needs to know where to
  203.  start when it disassembles a portion of the
  204.  program.  Enter the starting address for
  205.  disassembly here.
  206.  
  207. @@Options
  208.  There are many different options available so
  209.  that TimeStack may be customized.
  210.  
  211.  Look at each option individually to find out
  212.  more about it.
  213.  
  214. @@Options Type
  215.  The type of processor can have an effect on what
  216.  opcodes are illegal and how many clock cycles an
  217.  opcode uses.  Some processor families have a
  218.  large number of choices.  This may mean a
  219.  difference in timing characteristics or it may
  220.  just allow that specific name to be chosen for
  221.  display purposes.
  222.  
  223.  Any time a processor is picked, the clock divisor
  224.  value is reset to a default value for that
  225.  processor.
  226.  
  227. @@Options Clock
  228.  This is used to specify the clock rate of the
  229.  processor.  It is used to calculate how many
  230.  microseconds the maximum and minimum execution
  231.  times are in the Analysis Results window.
  232.  
  233.  The number entered is in megahertz.  It must be
  234.  between 0 and 200 MHz.  It is a floating point
  235.  number with at least five digits of accuracy.
  236.  It may be entered as a regular number or using
  237.  scientific notation.
  238.  
  239. @@Options Divisor
  240.  Every processor has a factor that the external
  241.  clock input is divided by.  The external clock
  242.  is divided by this value to obtain an internal
  243.  clock that is referred to as the cycle time.
  244.  
  245.  Most processors have a fixed value for this
  246.  internal divisor but it may be changed here.
  247.  
  248.  The number entered must be between 0 and 256.
  249.  It is a floating point number with at least
  250.  five digits of accuracy.  It may be entered as
  251.  a regular number of using scientific notation.
  252.  
  253. @@Options Get
  254.  Gets additional information on the current state
  255.  of TimeStack.
  256.  
  257.  This includes filenames, current processor type,
  258.  clock rate, clock divisor, and memory available.
  259.  
  260. @@Options Config Auto
  261.  This allows the configuration to automatically be
  262.  saved when Quiting.
  263.  
  264.  Yes - sets up TimeStack to automatically save the
  265.        configuration when Quiting.
  266.  
  267.  No -  does not allow automatic saving of the
  268.        configuration when Quiting.
  269.  
  270. @@Options Node Auto
  271.  This allows the node list to automatically be
  272.  saved when Quiting.
  273.  
  274.  Yes - sets up TimeStack to automatically save the
  275.        node list when Quiting.
  276.  
  277.  No -  does not allow automatic saving of the
  278.        node list when Quiting.
  279.  
  280. @@Print
  281.  The information obtained from the analysis may be
  282.  saved in a file on disk or sent to a printer.
  283.  
  284. @@Print Comments
  285.  A line at the top of the printed information may
  286.  optionally contain a comment.  That line is
  287.  entered here and remains until replaced with
  288.  another line.
  289.  
  290. @@Print Save
  291.  Outputs the current analysis results to a file.
  292.  
  293.  This file is usually saved for printing later.
  294.  
  295. @@Print Output
  296.  Outputs the current analysis results to a printer.
  297.  The output is sent to the DOS print device PRN.
  298.  
  299.  Be sure the printer is turned on, loaded with
  300.  paper, and on-line.
  301.  
  302. @@Print Opening
  303.  There is a problem opening this file for printing.
  304.  
  305. @@Print Error
  306.  There is a problem trying to communicate with
  307.  the printer.  This could be caused by a couple
  308.  of different things.
  309.  
  310.  1. Be sure the printer is plugged in and turned
  311.     on.  Make sure all of the printer cables are
  312.     connected correctly.
  313.  
  314.  2. Check that it has not run out of paper.
  315.  
  316.  3. Look to see that is it on-line.
  317.  
  318. @@Quit
  319.  Quit the TimeStack program.  If the Special Nodes
  320.  have been modified in any way and the 'save
  321.  special nodes automatically' feature is not active,
  322.  a prompt is given to ask if the information should
  323.  really be saved.
  324.  
  325.  If the special nodes are to be saved and no
  326.  filename has been entered then it will be prompted.
  327.  
  328. @@Quit Node
  329.  The current special nodes will be saved if you
  330.  choose 'Yes' at this time.
  331.  
  332.  Any changes made to the special nodes will be
  333.  lost if 'No' is chosen.
  334.  
  335. @@Quit Configuration
  336.  The current configuration will be saved if you
  337.  choose 'Yes' at this time.
  338.  
  339.  Any changes made to the configuration will be
  340.  lost if 'No' is chosen.
  341.  
  342. @@Config Error Reading
  343.  The configuration file that was entered was not
  344.  found while trying to open it for the first time.
  345.  
  346. @@Config Header
  347.  The first line of information in the configuration
  348.  file is bad.  It probably means the file is not
  349.  a valid TimeStack configuration file.
  350.  
  351. @@Config Version
  352.  The configuration file version is greater than the
  353.  program reading it.
  354.  
  355. @@Config Revision
  356.  The configuration file revision is not the same as
  357.  the program reading it.
  358.  
  359. @@Config Size
  360.  The configuration file is too big.  This indicates
  361.  some problem with the file.
  362.  
  363. @@Config Error Writing
  364.  The configuration file that was entered had an
  365.  error while trying to open it for writing.
  366.  
  367. @@CPU Error
  368.  The processor type in the configuration file was
  369.  not a valid choice for this program.  A default
  370.  will be selected as the processor type.
  371.  
  372. @@CPU Not Found
  373.  The processor type in the configuration file was
  374.  not found.  A default will be selected as the
  375.  processor type.
  376.  
  377. @@CPU Selection
  378.  Choose one of the given processors.  These are
  379.  the only processors this version of the program
  380.  will recognize.
  381.  
  382.  Some of the processors may operate identically
  383.  but have been given their own entry to allow for
  384.  more specific documentation.
  385.  
  386. @@Error
  387.  No help is available.  Refer to the TimeStack
  388.  User's Guide.
  389.  
  390. @@Infinite Loops
  391.  Infinite loops in the program will eventually
  392.  cause the analysis to reach an internal limitation
  393.  and stop.
  394.  
  395.  If a memory limitation is reached, it is up to
  396.  the user to determine if or how the program entered
  397.  into a large or infinite loop.  In general, it is
  398.  not a good idea to try and time loops that run for
  399.  more than a couple of hundred iterations.
  400.  
  401.  Also, it may be that one of the conditional
  402.  branches in the program has not been set up or
  403.  set up correctly.  It may be possible to narrow
  404.  down the area that is the problem by changing the
  405.  start and stop addresses to analyze a smaller
  406.  portion.
  407.  
  408.  A solution to timing loops that run for a large
  409.  number of times is to time the loop when it is
  410.  taken only once.  Then time the loop when it
  411.  is taken twice.  Calculate the difference
  412.  between these results and you have how long each
  413.  iteration of the loop takes.
  414.  
  415. @@Hex Files
  416.  Some common problems with hex files are as
  417.  follows.
  418.  
  419.  Not all address ranges are valid.  The
  420.  given address may not exist in the hex file
  421.  that was loaded.
  422.  
  423. @@Illegal Opcodes
  424.  An illegal opcode means that the value in memory
  425.  at the indicated address was not a valid
  426.  instruction for the current processor type.
  427.  
  428.  It may be that the current processor type is set
  429.  incorrectly or the hex file that was loaded was
  430.  for another processor or the starting address was
  431.  incorrectly specified or the program is in error.
  432.  
  433. @@No Time
  434.  This opcode is not able to be included in the
  435.  timing analysis for this program.
  436.  
  437.  For some reason, the instruction is too difficult
  438.  to logically be analyzed by TimeStack.
  439.  
  440. @@Indirect Addressing JSR
  441.  The cycle time and worst stack depth must be
  442.  entered for a jump subroutine indirect instruction.
  443.  
  444.  If this information is not known then do an
  445.  analysis of the subroutine that is to be the
  446.  destination of this instruction.
  447.  
  448. @@Indirect Addressing JMP
  449.  A destination address is needed for a jump
  450.  indirect instruction.
  451.  
  452. @@Backwards Branching
  453.  If a backwards branch is encountered it is
  454.  possible for a loop structure to exist.
  455.  
  456.  The option to edit conditional branches is
  457.  given at this time so that if this is part of
  458.  a loop it can be set up.
  459.  
  460. @@Stack Mismatch
  461.  The stack depth when this conditional branch
  462.  is taken and when it falls through is different.
  463.  
  464.  This MIGHT indicate a path where the stack
  465.  could become unbalanced based on the logic.
  466.  
  467. @@Difficult Structures
  468.  Some loop structures are too difficult for
  469.  the analysis to calculate correctly.  The
  470.  conditional branch that should be modified
  471.  to help the analysis out is indicated.
  472.  
  473. @@Stop Address
  474.  The stop address that was entered for the
  475.  analysis was never reached.  Probably the
  476.  address entered was less than the starting
  477.  address, or it may have been greater than
  478.  the last return from subroutine instruction
  479.  in the subroutine.
  480.  
  481. @@Branch Past
  482.  A branch inside the analysis range branched
  483.  past the specified stop address.
  484.  
  485.  This could mean the stop address indicated was
  486.  shorter than intended.
  487.  
  488. @@Internal Error
  489.  An internal error has occurred that should not
  490.  have happened under normal circumstances.
  491.  
  492.  Please report this to BE, Inc.
  493.  
  494. @@Help Files
  495.  The help files were not found in the search path.
  496.  
  497.  The search path is the current directory of the
  498.  current drive followed by each directory in the
  499.  PATH environment variable.
  500.